Interface UserCreatedPDU

All Superinterfaces:
IPCObject
All Known Implementing Classes:
UserCreatedPDUImpl

public interface UserCreatedPDU extends IPCObject
Information provided by the PKI file:

    \class UserCreatedPDU
    
    \brief The UserCreatedPDU widget holds all the user created pdus for different scenarios.
    
    \example appWindow().getUserCreatedPDU()
    
Author:
Auto-generated
  • Method Details

    • setVisible

      void setVisible(boolean bVisible)
      Information provided by the PKI file:
      
          \brief Shows or hides this widget from view.
          
          \param bVisible, true to show this widget, false to hide it.
          
              
      Parameters:
      bVisible - Takes in a parameter of bVisible
    • setWidgetVisible

      void setWidgetVisible(String widgetName, boolean bVisible)
      Information provided by the PKI file:
      
          \brief Shows or hides the specified child widget.
          
          \param widgetName, where widgetName can be one of the following: NewScenarioBtn, DeleteScenarioBtn, OpenListWindowBtn, RemovePDUBtn.
          \param bVisible, true to show this child widget, false to hide it.
          
              
      Parameters:
      widgetName - Takes in a parameter of widgetName
      bVisible - Takes in a parameter of bVisible
    • setDisabled

      void setDisabled(boolean bDisable)
      Information provided by the PKI file:
      
          \brief Enables or disables input events to this widget.
          
          \param bDisabled, true to disable input events to this widget, false to enable input events.
          
              
      Parameters:
      bDisable - Takes in a parameter of bDisable
    • setWidgetDisable

      void setWidgetDisable(String widgetName, boolean bDisable)
      Information provided by the PKI file:
      
          \brief Enables or disables the specified child widget.
          
          \param widgetName, where widgetName can be one of the following: NewScenarioBtn, DeleteScenarioBtn, OpenListWindowBtn, RemovePDUBtn.
          \param bDisabled, true to disable input events to this child widget, false to enable input events.
          
              
      Parameters:
      widgetName - Takes in a parameter of widgetName
      bDisable - Takes in a parameter of bDisable
    • activateScenario

      void activateScenario(int index)
      Information provided by the PKI file:
      
          \brief Changes the scenario to the specified index.
          
          \param index, the index of the scenario of interest.
          
              
      Parameters:
      index - Takes in a parameter of index
    • deleteScenarioBtn_clicked

      void deleteScenarioBtn_clicked()
      Information provided by the PKI file:
      
          \brief Simulates clicking on the Delete scenario button.
          
              
    • newScenarioBtn_clicked

      void newScenarioBtn_clicked()
      Information provided by the PKI file:
      
          \brief Simulates clicking on the New scenario button.
          
              
    • scenarioInfoBtn_clicked

      void scenarioInfoBtn_clicked()
      Information provided by the PKI file:
      
          \brief Simulates clicking on the scearnio info "i" button.
          
              
    • toggleOpenListWindowBtn

      void toggleOpenListWindowBtn(boolean bEnable)
      Information provided by the PKI file:
      
          \brief Shows or hides the Toggle PDU List Window.
          
          \param bEnable, true to show the Toggle PDU List Window, false to hide it.
          
              
      Parameters:
      bEnable - Takes in a parameter of bEnable
    • setScenarioDescription

      void setScenarioDescription(String description)
      Information provided by the PKI file:
      
          \brief Sets the description for the current scenario.
          
          \param description, the description for the current scenario.
          
              
      Parameters:
      description - Takes in a parameter of description
    • firePDU

      void firePDU(int index)
      Information provided by the PKI file:
      
          \brief Sends out the PDU at the specified index.
          
          \param index, the index of the PDU of interest.
          
              
      Parameters:
      index - Takes in a parameter of index
    • colorPDU

      void colorPDU(int index)
      Information provided by the PKI file:
      
          \brief Opens the color picker for the PDU at the specified index.
          
          \param index, the index of the PDU of interest.
          
              
      Parameters:
      index - Takes in a parameter of index
    • editPDU

      void editPDU(int index)
      Information provided by the PKI file:
      
          \brief Opens the edit pdu dialog for the pdu at the specified index
          
          \param int index, the index of interest
          
              
      Parameters:
      index - Takes in a parameter of index
    • deletePDU

      void deletePDU(int index)
      Information provided by the PKI file:
      
          \brief Removes the PDU at the specified index.
          
          \param index, the index of the PDU of interest.
          
              
      Parameters:
      index - Takes in a parameter of index
    • addSimplePdu

      ADD_PDU_ERROR addSimplePdu(String src, String dst)
      Information provided by the PKI file:
      
          \brief Adds a simple pdu to the simulation using only device names
          \param src, the source device name
          \param dst, the destination device name
          
              
      Parameters:
      src - Takes in a parameter of src
      dst - Takes in a parameter of dst
      Returns:
      ADD_PDU_ERROR Returns a ADD_PDU_ERROR